home *** CD-ROM | disk | FTP | other *** search
/ EnigmA Amiga Run 1996 June / EnigmA AMIGA RUN 08 (1996)(G.R. Edizioni)(IT)[!][issue 1996-06][EARSAN CD VII].iso / earcd / comm2 / dbtkrv14.lha / DBTicker.doc < prev    next >
Text File  |  1996-04-10  |  13KB  |  421 lines
  1.  
  2. WARNING: NOT COMPLETE DOC, v.92
  3. *****************************************************************************
  4. ******  DBTicker V1.4  *****  ©1995 by Denis Bucher  *****  Shareware  ******
  5. *****************************************************************************
  6.  
  7.  
  8. GENERAL FEATURES :
  9. ~~~~~~~~~~~~~~~~~~
  10.  
  11.     Technical :
  12.          - Send received files to your links if they are linked
  13.             to that area.
  14.          - Users can link themselves with DBAreafix
  15.          - Infinite areas number
  16.          - Password for incoming files
  17.          - Possibility to create a copy of some files, for special
  18.                 use : For example the nodediffs
  19.          - All the functions supported by DBAreafix
  20.          - Very easily updatable !
  21.  
  22.     Simple configuration :
  23.          - Configuration editor in DLG or CLI (very simple)
  24.          - Can be added in the DLGMail process cycle
  25.          - You just have to create a file called FIDO:DBFile.ARE and
  26.             enter a line for each filearea to be managed
  27.          - Ready !
  28.  
  29.     Free :
  30.          - Shareware NOT limited if unregistered
  31.     
  32.     UpToDate :
  33.          - I'll take your suggestions, and one week
  34.             after, you'll have YOUR version
  35.              - For example, version 1.5d of DBAreafix is at least
  36.                 the 30th version !
  37.  
  38.  
  39.  
  40.  SUMMARY
  41.  ~~~~~~~
  42.                                                      (line)
  43.  
  44.   .....General Features.................................8.....
  45.   .....Summary.........................................40.....
  46.   .....Introduction....................................59.....
  47.   .....Installation....................................91.....
  48.   .....Updates Installation...........................185.....
  49.   .....Configuration..................................198.....
  50.   .....History........................................325.....
  51.   .....To Do..........................................349.....
  52.   .....Bugs...........................................364.....
  53.   .....Bug Report.....................................569.....
  54.   .....Contact the Author.............................578.....
  55.   .....Sos Author Contact.............................402.....
  56.  
  57.  
  58.  
  59.  
  60. Introduction :
  61. ~~~~~~~~~~~~~~
  62.  
  63.    The  first  thing to understand is what you need for the message part of
  64. your  node  to  work.  The messages themself are processed by a tosser, for
  65. example DLGMail and the *areas* are processed by DBAreafix.  It is the same
  66. for  the  files  :   The  file  areas  configuration  are  processed by the
  67. DBFilemgr module (included in DBAreafix) where the *files* are processed by
  68. this program, DBTicker.
  69.  
  70.    How  does  the file areas work ?  Each file is followed (or preceded ;-)
  71. on  your  modem  by another file, which has the format #?.TIC.  This "TICK"
  72. file  contains  all  information  about  the main file :  Password, sender,
  73. seen-by lines, name of the main file, etc ...  So when a .TIC file is found
  74. into  your  inbound directory, DLGMail calls your ticker program (DBTicker)
  75. who will process the file.
  76.  
  77.    The  Structure  of  DBFile.ARE looks much like DLGMail.ARE :  On a line,
  78. you have the keyword FILEAREA, spaces/tabs, the name of the directory where
  79. the  files  have  to  be kept, spaces/tabs, and the distribution list.  The
  80. name  of  the directories must be *4* *characters* long, dos convenient (No
  81. "/"  or  ":"  but  letters and numbers).  But all this is explained in this
  82. documentation ...
  83.  
  84.  
  85.  
  86.  
  87.  
  88.  
  89.  
  90.  
  91.  
  92. INSTALLATION :
  93. ~~~~~~~~~~~~~~
  94.  
  95.    You  have two ways for the installation of DBTicker.  The first with the
  96. supplied  AutoInstall  Script.  The second in following the instructions of
  97. this documentation.
  98.  
  99.    If  you  want  to  install DBTicker with the AutoInstall script (this is
  100. suggested),  you'll just have to double click on it, or to type the follow-
  101. ing command in a Shell (CLI) window :
  102.  
  103.    c:Execute DBTicker.autoinstall
  104.  
  105.    But  remember  that  if  you  installed  DBTicker  with this AutoInstall
  106. script,  you won't have completely installed it :  DBTicker is suggested to
  107. be included in the Sysop Menu in DLG Pro BB/OS.  It isn't necessary, but is
  108. proved to be sometimes useful, especially when you are already in the BBS.
  109.  
  110.  
  111. Part I : Manual installation of AutoInstall stuff
  112. -------------------------------------------------
  113.  
  114.    Instead of reading this Part, you may prefer to execute  AutoInstall  or
  115. to  read  the  AutoInstall script itself.  The following statements are the
  116. conditions for DBTicker to work.
  117.  
  118.    a) The  DBTicker executable and  DBTicker.script (the file which will be
  119.    executed  to  use  DBTicker in parsing mode) must be in Doors:DBAreafix/
  120.    and must be called "DBTicker" and "DBTicker.script".
  121.  
  122.    b) You should add DBTicker in the DLGMail Process Cycle :
  123.  
  124.     1. Execute DBTicker.script if .TIC files are found.
  125.  
  126.       To do that, add the following to FIDO:Batch/GenericTick.DMB
  127.  
  128.     DBTicker.script
  129.  
  130.    c) The option TICK in DLGMail.CFG **MUST** be enabled !  You simply have
  131.    to add "TICK 1" in DLGMail.CFG, or to replace "TICK 0" with "TICK 1".
  132.  
  133.  
  134. Part II : Manual installation
  135. -----------------------------
  136.  
  137.    Now that the main part is done, you just need to do facultative things.
  138.  
  139.    a)  Assigns :  Just have these two devices assigned, or do it now :  For
  140. DBTicker  to work, you need LOGS:  and DOORS:  to be assigned.  Add them to
  141. your  Startup-Sequence  so  that they will survive the next reboot, and add
  142. them now, for example in a Shell window.  How to do that :
  143.  
  144. assign LOGS:  dh0:Logs/
  145. assign DOORS: dh4:BBSConfig/
  146.  
  147.    It's obvious that you don't need to use the same paths ;-)
  148.  
  149.    b) Add DBTicker in the DLG Sysop menu :  Just go  to  "Configure Menus"
  150. in your DLG BBS, and "Select" the SYSOP menu _for_ _example_.  Then select
  151. "Add menu" item and answers the questions the following way :
  152.  
  153.    [ 1] Letter:                   K
  154.  * [ 2] Executable: (path/name)   Doors:DBAreafix/DBTicker CFG
  155.    [ 4] Description:              Ticker
  156.  * [ 5] Type:                     Executable
  157.    [ 6] Help File:                SYSOP/K
  158.  ! [ 7] Lower level:              255
  159.    [ 8] Upper level:              255
  160.    [ 9] Hidden:                   NO
  161.  * [10] Load type:                OVERLAY
  162.    [11] Ask user if sure:         NO
  163.  * [12] Pend messages:            YES
  164.  * [13] Cli mode:                 YES
  165.    [14] Pause on completion:      NO
  166.    [15] Log value:                None
  167.    [16] Activity string:          Configuring Areafix
  168.    [17] Priority:                 DEFAULT
  169.    [18] Edit help file
  170.  
  171.    The legend is :
  172.  
  173.  * = DON'T CHANGE !!!
  174.  ! = Beware : Users should NEVER have access to that !
  175.  
  176.  
  177.    Now,  installation  of DBTicker is complete :-) I would suggest that you
  178. read now the "Configuration" chapter.
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186. UPDATES INSTALLATION :
  187. ~~~~~~~~~~~~~~~~~~~~~~
  188.  
  189.    Just execute the AutoInstall script ...
  190.  
  191.  
  192.  
  193.  
  194.  
  195.  
  196.  
  197.  
  198.  
  199. CONFIGURATION :
  200. ~~~~~~~~~~~~~~~
  201.  
  202.    The  way  to configure DBTicker can be summarized in one word, or rather
  203. in a single command :
  204.  
  205. DBTicker CFG
  206.  
  207.    Now  that you (maybe) configured a DLG menu to do that, you may also use
  208. the menu item instead of a CLI command, but Doors:DBAreafix/DBTicker CFG is
  209. always valid.
  210.  
  211.    When  you enter the configuration menu, there is some choices going from
  212. 4 to 4.  Just type number + RETURN to enter the sub-menu ...
  213.  
  214.    We will now review each configuration sub-menu, one by one,  but PLEASE
  215. REMARK that this documentaion about "configuration" is absolutely *not* ne
  216. cessary ... You could just enter the config and see yourself ...
  217.  
  218.    FIRST TIME suggested order : 3, 4, 7, 5 !
  219.  
  220.    0. Quit
  221.    -------
  222.       Just type RETURN to exit.  DB!Ticker! will there ask you  whether you
  223.    would like to save or not. Default (return or any key) is YES.
  224.  
  225.    1. Path
  226.    -------
  227.       This is the path to your Netmail area. If you enter "1", you will be
  228.    able to change it ... just in case !
  229.  
  230.    2. Last Message Parsed
  231.    ----------------------
  232.       This is the last message parsed, in your netmail area.  It shouldn't
  233.    normally be changed, but if you want to re-answer to an Areafix message
  234.    which would be message 345 and this displays 350, just enter 344 :-)
  235.  
  236.    3. BBS Name
  237.    -----------
  238.       This is the name displayed, for example in "Messages areas available
  239.    at #######", where ######## could be "The Home of the Programmer"
  240.  
  241.    4. Edit People/Passwords
  242.    ------------------------
  243.       In this sub-menu,  you will be able to edit the links you would like
  244.    to give an access to Areafix.
  245.  
  246.       If you choosed this sub-menu, you will be given two choices :
  247.    a) List/Add/Edit
  248.    b) List/Add/Remove
  249.  
  250.       It is very simple :  both have  the "list" and "add" functions,  but
  251.    each has in addition a third function, "edit" or "remove".
  252.  
  253.       Choose for example List/Add/Edit ...   You'll see  a *list*  of your
  254.    links, with two columns :  The first is their name, the second is their
  255.    Areafix password.
  256.  
  257.       One of the listed item is called "NEW".  If you choose "New", you'll
  258.    be able to *add* a new user to this list.
  259.  
  260.       If you choose an user, you'll be able to change his name and his
  261.    password : This is the *edit* function.
  262.  
  263.       Now, choose the second menu (List/Add/Remove).  You'll have exactely
  264.    the same possibilities of *listing* and *adding*, but instead of *edit*
  265.    you'll be *deleting* the choosen user.
  266.  
  267.    5. User Domains Access
  268.    ----------------------
  269.       It's obvious that  your links cannot have access  to any area. As an
  270.    simple example : The Sysops-reserved areas ... So each *type* of *area*
  271.    should be represented as an "DOMAIN".
  272.  
  273.       Examples of Domains :
  274.  
  275.    Sysop_Fidonet
  276.    Fidonet
  277.    Local_areas
  278.    Amiganet
  279.    Private
  280.    Adults_only
  281.  
  282.       COMPATIBILITY with DLGMail:
  283.       To define what domain an area belongs to, you just have to edit your
  284.    fido:DLGMail.are, that you should know very well. If you want to define
  285.    an other domain for all the _following_ areas, just add a MYADDRESS DLG
  286.    Mail command. For Example, to make 
  287.  
  288.       The Access is either '0' or '9'.  0 means no access and 9 means full
  289.    access.  If you need some other levels,  just ask me to add them in the
  290.    program.
  291.  
  292.       When entering this submenu,  you'll see the list of your links  with
  293.    their accesses. Just type the number of the link to edit him/she.
  294.  
  295.       When editing a link,  just type  the number of the access  to toggle
  296.    between "Access" and "No Access".
  297.  
  298.    7. Edit Domains
  299.    ---------------
  300.       Each domain must be known to DB!Ticker! by its name. This submenu has
  301.    only this aim : Edit the list of domains.  Read point 7. to obtain more
  302.    information about domains.
  303.  
  304.       The editing system (list/add/edit) is the same as in submenu 4.
  305.  
  306.    6. Remplacement Names
  307.    ---------------------
  308.       Your links must normally write to Areafix or DB!Ticker!. If you want,
  309.    you may enable them to write  to "The_nicest_areafix_never_seen"  or to
  310.    árèàfîx (in some exotic language ;-))
  311.  
  312.       The editing system (list/add/edit) is the same as in submenu 4.
  313.  
  314.  
  315.  
  316.  
  317.  
  318.  
  319.  
  320.  
  321.  
  322.  
  323.  
  324.  
  325.  
  326. HISTORY :
  327. ~~~~~~~~~
  328.  
  329.  1.0   |  25.5.95  First version
  330.  1.1   |  31.5.95  Checks passwords
  331.        |           Logfile faster + more accurate
  332.        |           Preferences implemented
  333.        |           A complete preferences editor menu
  334.  1.2   |   4.6.95  Some bugs removed
  335.        |   8.6.95  Guru bug removed : If file to rename
  336.        |           already exists, add ",1" ",2" ",3" suffix
  337.        |   8.6.95  Added KEEP/NOKEEP
  338.        |  18.6.95  KEEP/NOKEEP *is* working
  339.        | 14.10.95  Added stack (std 20kb -> 40kb)
  340.  1.3   |  2.12.95  Manual done
  341.        | 14.12.95  Severe bug found ! Areas containing a '.'
  342.        |           were NOT supported. Now they are.
  343.        |   8.3.96  Thought of uploading on DLG. Decision is to
  344.        |           do a third-party program that will simply
  345.        |           upload in DLG
  346.  1.4   |  10.4.96  Release on Aminet
  347.  
  348.  
  349.  
  350. TO DO :
  351. ~~~~~~~ 
  352.  
  353.      File areas (from fidonet/your node) should be used in conjonction with
  354.      the file areas on the BBS
  355.  
  356.      Documentation :
  357.         Add an index
  358.  
  359.      Others :
  360.         Just suggest !
  361.  
  362.  
  363.  
  364.  
  365. BUGS :
  366. ~~~~~~
  367.      None known, except "those" here in "TO DO".
  368.  
  369.  
  370. BUG REPORT :
  371. ~~~~~~~~~~~~
  372.      If you find a small bug, I garantee to fix it in three days !!!
  373.      If it is bigger ... let's say ... 1.5 week ?
  374.  
  375.  
  376.  
  377.  
  378.  
  379. CONTACT THE AUTHOR :
  380. ~~~~~~~~~~~~~~~~~~~~
  381.  
  382.                         Fidonet :              2:301/317
  383.                         Amiganet :            39:110/311
  384.                         email1 :       dbucher@alphanet.ch
  385.                         email2 :    bucherd5@sc2a.unige.ch
  386.  
  387.   WWW :                 http://www.unige.ch/etudiants/dbucher/dbt
  388.  
  389.   Via Post :        Denis Bucher
  390.             Villarets 35
  391.             CH-2036 Cormondrèche
  392.             SWITZERLAND
  393.  
  394.   Support BBS :        THOT-Programmer BBS
  395.             ZyXEL 41-22-8000 622
  396.  
  397.  
  398.  
  399.  
  400.  
  401.  
  402. SOS CONTACT :    (if my addresses are no more valid)
  403. ~~~~~~~~~~~~~
  404.  
  405.      1) Try Denis Bucher @ 2:301/317.0 (fidonet)
  406.         or denis.bucher@thotp.fn.alphanet.ch
  407.         or dbucher@alphanet.ch
  408.         or bucherd5@sc2a.unige.ch
  409.  
  410.      2) Ask Michel Roch at 2:301/315 where you can join me.
  411.  
  412.      3) Write to my postal address :-))
  413.  
  414.      4) Ask anybody in 2:301/3xx to find me (or him) in the nodelist.
  415.      5) Ask anybody in 2:301/3xx to find Bertrand Schmitt in the nodelist.
  416.  
  417.  
  418.  
  419.  
  420.  
  421.